﻿#region Copyright and License Notice
// Copyright (C)2010-2016 - Rob Levine and other contributors
// http://configgen.codeplex.com
// 
// This file is part of ConfigGen.
// 
// ConfigGen is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// ConfigGen is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License and 
// the GNU Lesser General Public License along with ConfigGen.  
// If not, see <http://www.gnu.org/licenses/>
#endregion

using System.Collections.Generic;

namespace ConfigGen.ConsoleApp.Core.CommandLineOptionCore
{
    /// <summary>
    /// 
    /// </summary>
    /// <typeparam name="T"></typeparam>
    public interface ICommandLineOption<T>
    {
        /// <summary>
        /// Gets the short name of the command line argument, without the leading hyphen, e.g. for -i, returns "i"
        /// </summary>
        string ShortName { get; }

        /// <summary>
        /// Gets the long name of the command line argument, without the leading hyphens, e.g. for --inhibit-write, returns "inhibit-write"
        /// </summary>
        string LongName { get; }

        /// <summary>
        /// Gets help text for this command line option.
        /// </summary>
        string HelpText { get; }

        /// <summary>
        /// Gets a help string containing the args usage for this option, e.g. for an option that looks 
        /// like --settings-file &lt;filename&gt;, this property would return &lt;filename&gt;.
        /// </summary>
        string ArgsUsage { get;  }

        /// <summary>
        /// Applies the option represented by this instance to the supplied settings instance.
        /// </summary>
        /// <param name="settings">The settings object.</param>
        void ApplyOptionToSettings(T settings);

        /// <summary>
        /// Processes the argument queue by consuming (dequeuing) any arguments used by this instance.
        /// </summary>
        /// <param name="args">Args queue from which to consume args</param>
        void ConsumeArgumentsFromQueue(Queue<string> args);
    }
}
